Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(api): added openapi endpoints #1422

Merged
merged 5 commits into from
Jan 22, 2025
Merged

Conversation

danpoletaev
Copy link
Contributor

Recently, we introduced two new endpoints that return the OpenAPI specification:

  • /acts/<actorId>/builds/<buildId>/openapi-specification
  • /actor-builds/<buildId>/openapi-specification

This PR updates the documentation to include these endpoints.

@TC-MO Let me, please, know if you think we should add any additional information 🙏

@danpoletaev danpoletaev added the adhoc Ad-hoc unplanned task added during the sprint. label Jan 21, 2025
@github-actions github-actions bot added this to the 107th sprint - Platform team milestone Jan 21, 2025
@github-actions github-actions bot added the t-platform Issues with this label are in the ownership of the platform team. label Jan 21, 2025
Copy link
Member

@jirimoravcik jirimoravcik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't we also add an endpoint for default build? Is it going to be added in another PR?

apify-api/openapi/components/tags.yaml Outdated Show resolved Hide resolved
apify-api/openapi/components/tags.yaml Outdated Show resolved Hide resolved
@danpoletaev
Copy link
Contributor Author

Didn't we also add an endpoint for default build? Is it going to be added in another PR?

I'll add it in another PR

@danpoletaev danpoletaev requested a review from B4nan January 22, 2025 09:58
Copy link
Contributor

@TC-MO TC-MO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've rewritten the descriptions slightly to address few things

  • Actor capitalization
  • Consistency
  • Small descriptions to give more context instead just giving the note about similar endpoints

@danpoletaev danpoletaev requested review from TC-MO and B4nan and removed request for B4nan January 22, 2025 14:00
Copy link
Member

@B4nan B4nan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just one nit

example: Your Magic Actor
version:
type: string
example: "1.0"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the quoting is inconsistent here, lets use single quotes everywhere (there are more places using double quotes, not just in this file)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, fixed in the files I've changed, but it is harder to change everywhere else. I think it should be fixed in lint, but we'll need to set up yaml lint for that...

@danpoletaev danpoletaev merged commit 8c7e259 into master Jan 22, 2025
7 checks passed
@danpoletaev danpoletaev deleted the feat/added-openapi-endpoints branch January 22, 2025 14:45
@fnesveda fnesveda added the validated Issues that are resolved and their solutions fulfill the acceptance criteria. label Jan 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
adhoc Ad-hoc unplanned task added during the sprint. t-platform Issues with this label are in the ownership of the platform team. validated Issues that are resolved and their solutions fulfill the acceptance criteria.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants